<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: JCompositeIndex.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.annotation;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.lang.annotation.Documented;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.lang.annotation.Retention;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.lang.annotation.RetentionPolicy;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.lang.annotation.Target;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>/**<a name="line.15"></a>
<span class="sourceLineNo">016</span> * Java annotation defining a composite index on a {@link JSimpleClass}-annotated class.<a name="line.16"></a>
<span class="sourceLineNo">017</span> *<a name="line.17"></a>
<span class="sourceLineNo">018</span> * &lt;p&gt;<a name="line.18"></a>
<span class="sourceLineNo">019</span> * A composite index is an index on two or more fields (to define a single-field index,<a name="line.19"></a>
<span class="sourceLineNo">020</span> * just set {@link JField#indexed} to true). All fields indexed in a composite index<a name="line.20"></a>
<span class="sourceLineNo">021</span> * must be (a) simple and (b) not a sub-field of a complex field.<a name="line.21"></a>
<span class="sourceLineNo">022</span> * &lt;/p&gt;<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * @see JSimpleClass<a name="line.24"></a>
<span class="sourceLineNo">025</span> */<a name="line.25"></a>
<span class="sourceLineNo">026</span>@Retention(RetentionPolicy.RUNTIME)<a name="line.26"></a>
<span class="sourceLineNo">027</span>@Target({})<a name="line.27"></a>
<span class="sourceLineNo">028</span>@Documented<a name="line.28"></a>
<span class="sourceLineNo">029</span>public @interface JCompositeIndex {<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>    /**<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * The name of this composite index. Must be globally unique.<a name="line.32"></a>
<span class="sourceLineNo">033</span>     *<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * @return the index name<a name="line.34"></a>
<span class="sourceLineNo">035</span>     */<a name="line.35"></a>
<span class="sourceLineNo">036</span>    String name();<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>    /**<a name="line.38"></a>
<span class="sourceLineNo">039</span>     * The storage ID for this composite index. Value should be positive; if zero, the configured<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * {@link org.jsimpledb.StorageIdGenerator} will be consulted to auto-generate a value.<a name="line.40"></a>
<span class="sourceLineNo">041</span>     *<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * @return the index storage ID<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * @see org.jsimpledb.StorageIdGenerator#generateCompositeIndexStorageId StorageIdGenerator.generateCompositeIndexStorageId()<a name="line.43"></a>
<span class="sourceLineNo">044</span>     */<a name="line.44"></a>
<span class="sourceLineNo">045</span>    int storageId() default 0;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>    /**<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * The names of the indexed fields, in the desired order. At least two fields must be specified.<a name="line.48"></a>
<span class="sourceLineNo">049</span>     *<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @return the names of the indexed fields<a name="line.50"></a>
<span class="sourceLineNo">051</span>     */<a name="line.51"></a>
<span class="sourceLineNo">052</span>    String[] fields();<a name="line.52"></a>
<span class="sourceLineNo">053</span>}<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>




























































</pre>
</div>
</body>
</html>
